(logo)  AWeb ARexx Commands

Inquiry commands

GET (general)
GET ACTIVEPORT
GET CACHE
GET CLIP
GET COOKIES
GET FINALURL
GET FOCUS
 GET FRAMES
GET FRAMESET
GET HOTLIST
GET IMAGES
GET INFO
GET LINKS
GET MIME
 GET NAMES
GET PORT
GET SCREEN
GET SECURE
GET SELECTION
GET SOURCE
GET STATUS
 GET STATUSD
GET TITLE
GET TRANSFERS
GET URL
GET VERSION
GET WINDOW
GET WINDOWS

GET

Template:

   GET ITEM/A,TARGET/K,VAR/K,STEM/K,PAT=PATTERN/K,ALL/S
Obtain various kinds of information about the program or the document in the addressed window or in the specified frame.

Argument Description
ITEM Specifies the kind of information to obtain. See above for a list of all valid item names.
TARGET The target name of the window or frame to obtain information from.
VAR The name of a variable to return the information in. If no name is specified, the single valued result will be returned in the reserved ARexx variable RESULT.
STEM The name of a stem variable to return an array of structured information in. Do not include the trailing period in this name.
PATTERN The meaning of this argument depends on the ITEM obtained.
ALL The meaning of this switch depends on the ITEM obtained.
Not all arguments are valid for all ITEM values. Refer to the individual descriptions for the template containing all valid arguments.

GET ACTIVEPORT

Template:

   GET ACTIVEPORT  VAR/K
Obtain the name of the ARexx port associated with the most recently activated AWeb window. Useful in ARexx macros started via a shell script or shell command to find the active window.

GET CACHE

Template:

   GET CACHE  STEM/K,PAT=PATTERN/K
Obtain details of the files currently residing in AWeb's disk cache.

If a PATTERN is given, then only the cache entries will be returned that match this URL pattern using standard DOS wildcards. When the pattern does not include a scheme (like http://), the scheme part of each URL is not included in the pattern match. So a pattern "foo.bar#?" matches "http://foo.bar/xyz.html" and "ftp://foo.bar/zoo".

Structured information components
Name Description
URL The URL for the cached file.
TYPE The MIME type of the cached file.
SIZE The size in bytes of the cached file.
DATE The date that this file was retrieved, in internal system days (like returned by the DATE('I') command).
FILE The full path and file name of the cached copy.

IMPORTANT: Never delete or modify these files other than via AWeb ARexx commands!

GET CLIP

Template:

   GET CLIP  VAR/K
Obtain the current contents of the clipboard. Due to various internal limitations, a maximum of 8192 characters is returned.

GET COOKIES

Template:

   GET COOKIES  STEM/A/K
Obtain an array with the details of all currently known HTML cookies.

Structured information components
Name Description
NAME The name of this cookie.
VALUE The value of this cookie.
DOMAIN The domain for which this cookie is sent.
PATH The path (within the domain) for which this cookie is sent.
EXPIRES The date and time in GMT string format when this cookie will expire. If this field is the empty string, the cookie is temporary and will not be remembered when AWeb exits.
COMMENT An optional comment for the cookie.
VERSION An optional version number for the cookie.
FLAGS A string containing zero or more of the following letters:
 A  Changes to this cookie will be accepted by AWeb without showing the cookie alert requester.
 D  The DOMAIN was inferred from the URL of the document that set the cookie, it was not explicitly given when the cookie was set.
 P  The PATH was inferred from the URL of the document that set the cookie, it was not explicitly given when the cookie was set.
 S  The cookie will only be sent to the server over a secure connection.

GET FINALURL

Template:

   GET FINALURL  TARGET/K,VAR/K
Obtain the final URL of the document currently displayed in the addressed window or the specified frame.

There is a difference with the GET URL command when dealing with relocated URLs. This happens when the result of fetching one URL is only a reference to another document with a different URL. The standards say specifically that for one such type of relocation, the original URL must be used in the interface to the user, not the second one that is the actual URL for the document displayed. The GET URL command returns the original URL in this case, while the GET FINALURL command returns the second one.

GET FOCUS

Template:

   GET FOCUS  VAR/K
Obtain the frame ID of the frame that currently has the keyboard scroll focus. If the main window has the focus, an empty string will be returned.

GET FRAMES

Template:

   GET FRAMES  TARGET/K,STEM/A/K,ALL/S
Obtain an array with the names and IDs of all frames directly subordinate to the command's target window or frame. If the ALL switch is set, also details of all nested frames are returned.

Structured information components
Name Description
ID A unique (within the addressed window) identification for the frame. Frames do not necessarily have a name, but will always have an ID. The ID is recognized by the leading # sign, and can be used in TARGET ARexx arguments.

Note that this ID can not be used in HTML TARGET attributes.

NAME Name of the frame, as defined by the NAME attribute in the <FRAME> HTML tag.
TITLE The title of the document loaded in the frame. If the document has no title defined, the URL of this document is returned.
URL The URL of the document loaded in the frame.

GET FRAMESET

Template:

   GET FRAMESET  TARGET/K,VAR/K
Obtain a boolean value specifying if the document in the target window or frame is a frameset document. If the document is a frameset document, "1" is returned. If the document is a normal document, "0" is returned. Note that normal documents still can contain inlined frames (<IFRAME>).

GET HOTLIST

Template:

   GET HOTLIST  STEM/A/K
Obtain an array with all entries of AWeb's hotlist.

Structured information components
Name Description
GROUP "1" if this array element defines a group, or "0" if this array element defines a single entry.
TITLE Title of the group or entry, as shown in the hotlist.
URL URL of this entry. Only defined for single entries, not for groups.
OWNER The array index number for the group that is the direct owner of this array element. This will be 0 if this element has no owner (it is a root level group, or an unassigned entry).

GET IMAGES

Template:

   GET IMAGES  TARGET/K,STEM/A/K
Obtain an array with information of all embedded images in the HTML document in the addressed window or the specified frame.

Structured information components
Name Description
ALT The ALT text for this image, if any.
TYPE The type of image. This will be one of the following:
BACKGROUND The document's background image.
IMAGE Not any of the other, special images.
ISMAP A server side image map.
USEMAP A client side image map.
URL The URL for the image.

GET INFO

Template:

   GET INFO  TARGET/K,STEM/A/K
Obtain HTTP headers and <META> and <LINK> information from the document in the addressed window or the specified frame.

Structured information components
Name Description
TYPE Type of information. This will be one of the following:
CACHE The document was read from AWebs cache. The VALUE component will contain "1".
HTTP HTTP transfer header.
META HTML <META> information.
LINK An HTML <LINK> anchor.
VALUE Depending on the returned TYPE: the HTTP header, the META name and contents, or the LINK title.
URL The URL linked to. Only present if TYPE equals "LINK".

GET LINKS

Template:

   GET LINKS  TARGET/K,STEM/A/K
Obtain an array with information of all hyperlinks in the HTML document in the addressed window or the specified frame.

Structured information components
Name Description
TARGET The target frame name, as defined in the TARGET HTML attribute.
URL The URL this link points to.

GET MIME

Template:

   GET MIME  TARGET/K,VAR/K
Obtain the MIME content type of the document currently displayed in the addressed window or the specified frame.

GET NAMES

Template:

   GET NAMES  TARGET/K,STEM/A/K
Obtain an array with all fragment names (defined by <A NAME="name">) in the HTML document in the addressed window or the specified frame.

Structured information components
Name Description
NAME The fragment name.

GET PORT

Template:

   GET PORT  TARGET/K
Obtain the ARexx portname for the window that contains the frame with the specified name.

GET SCREEN

Template:

   GET SCREEN  VAR/K
Obtain the name of the public screen that AWeb uses to open its windows on.

SECURE

Template:

   GET SECURE  TARGET/K,VAR/K
Obtain a boolean value specifying if the document in the target window or frame is retrieved over a secure connection. If the document is secure, "1" is returned, else "0" is returned.

GET SELECTION

Template:

   GET SELECTION  VAR/K
Obtain the currently selected text.

Note that due to an ARexx limitation, only the first 65535 bytes are returned.

GET SOURCE

Template:

   GET SOURCE  TARGET/K,VAR/K
Obtain the source code of the document currently displayed in the addressed window or the specified frame.

Note that due to an ARexx limitation, only the first 65535 bytes are returned.

STATUS

Template:

   GET STATUS  VAR/K
Obtain the current text in the status field of the addressed window. Note that this text may be obscured by dynamic text, see the GET STATUSD command.

STATUSD

Template:

   GET STATUSD  VAR/K
Obtain the dynamic text currently displayed in the status field of the addressed window. Dynamic text will be displayed if the mouse is over an active element in the document, like a hyperlink.

This dynamic text obscures any static text, see the GET STATUS command. Static text is only visible if the dynamic text is the empty string.

GET TITLE

Template:

   GET TITLE  TARGET/K,VAR/K
Obtain the title of the document currently displayed in the addressed window or the specified frame. If the document has no title defined, the URL of this document is returned.

GET TRANSFERS

Template:

   GET TRANSFERS  STEM/A/K
Obtain all currently active transfers (loading documents). This is essentially the same information as shown in the network status window.

The information returned is a snapshot. Immediately after this command returns the actual transfer status may already have changed.

Structured information components
Name Description
URL The URL that is being downloaded.
STATUS A number designating the status of this transfer. It will contain one of the following values:
1 Queued
2 Started
3 Looking up
4 Connecting
5 Logging in
6 Scanning news
7 Uploading
8 Waiting for response
9 Reading data
READ If STATUS is 9, the number of characters already downloaded.
TOTAL The expected size of the document, in characters.

This information is not always available. If the expected size is unknown, TOTAL will be set to zero.

LOADID An ID number to identify the transfer. Use this number in the CANCEL command to cancel a specific transfer.

GET URL

Template:

   GET URL  TARGET/K,VAR/K
Obtain the URL of the document currently displayed in the addressed window or the specified frame.

See the GET FINALURL command for an explanation of URL relocation.

GET VERSION

Template:

   GET VERSION  VAR/K
Obtain the version of AWeb. The string returned starts with numeric "version.revision".

GET WINDOW

Template:

   GET WINDOW  VAR/K
Obtain the rectangle describing the location and size of the addressed window.

GET WINDOWS

Template:

   GET WINDOWS  STEM/A/K
Obtain an array with details of all open AWeb windows.

Structured information components
Name Description
PORT The name of the ARexx port of the window.
RECT A rectangle describing the location and size of the window.
ZOOMED If the window is in zoomed state, this contains "1", else this contains "0".